Skip to main content
GET
/
v1
/
invoices
/
{id}
/
events
List invoice events
curl --request GET \
  --url https://api.hyperline.co/v1/invoices/{id}/events \
  --header 'Authorization: Bearer <token>'
{
  "meta": {
    "total": 1,
    "taken": 1,
    "skipped": 0
  },
  "data": [
    {
      "id": "evt_01HW8R3K2N9YV5Z7TQXJ4M2GHD",
      "name": "API call from europe-west1",
      "event_type": "api_call",
      "timestamp": "2024-10-20T14:32:11.000Z",
      "properties": {
        "region": "europe-west1",
        "endpoint": "/v1/customers"
      },
      "billing": {
        "invoice_id": "inv_1eTaiytfA0i2Va",
        "invoice_line_item_id": "ili_0FACNpeoEFkGu3",
        "product_id": "itm_KbLcWt2qm5p1S2",
        "price_name": null,
        "amount": 12,
        "amount_excluding_tax": 10,
        "currency": "EUR"
      }
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.hyperline.co/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Query Parameters

take
number | null
default:50
Required range: 0 <= x <= 100
skip
number | null
default:0
Required range: x >= 0
order
enum<string>
default:desc

Sort direction.

Available options:
asc,
desc
Example:

"desc"

sort
enum<string>

Field used to sort the results.

Available options:
timestamp
product_id
string
product_id__not
string
product_id__isNull
string
product_id__isNotNull
string
product_id__equals
string
product_id__contains
string
product_id__startsWith
string
product_id__endWith
string
event_type
string
event_type__not
string
event_type__isNull
string
event_type__isNotNull
string
event_type__equals
string
event_type__contains
string
event_type__startsWith
string
event_type__endWith
string
timestamp
string<date-time>
timestamp__not
string<date-time>
timestamp__isNull
string<date-time>
timestamp__isNotNull
string<date-time>
timestamp__equals
string<date-time>
timestamp__lt
string<date-time>
timestamp__lte
string<date-time>
timestamp__gt
string<date-time>
timestamp__gte
string<date-time>

Response

meta
object
required
data
object[]
required

List of InvoiceEvent.